| Post | /projects/{projectId}/roles |
In This Topic
Description
Creates or updates an array of roles in the project
Parameters
| Name | Description | Data Type |
|---|
| projectId | the id of the project | string |
Request (application/json)
The request body is of type object.
Overview
 |
 |
 |
 |
Alarms : boolean
set it to true to specify the type of configuration privileges available to users who are assigned to the role. |
|
Classes : boolean
set it to true to specify the type of configuration privileges available to users who are assigned to the role. |
|
Clients : boolean
set it to true to specify the type of configuration privileges available to users who are assigned to the role. |
|
DatabaseLogging : boolean
set it to true to specify the type of configuration privileges available to users who are assigned to the role. |
|
Devices : boolean
set it to true to specify the type of configuration privileges available to users who are assigned to the role. |
|
GlobalParameters : boolean
set it to true to specify the type of configuration privileges available to users who are assigned to the role. |
|
Objects : boolean
set it to true to specify the type of configuration privileges available to users who are assigned to the role. |
|
Points : boolean
set it to true to specify the type of configuration privileges available to users who are assigned to the role. |
|
Ports : boolean
set it to true to specify the type of configuration privileges available to users who are assigned to the role. |
|
Projects : boolean
set it to true to specify the type of configuration privileges available to users who are assigned to the role. |
|
RemoteProjects : boolean
set it to true to specify the type of configuration privileges available to users who are assigned to the role. |
|
Resources : boolean
set it to true to specify the type of configuration privileges available to users who are assigned to the role. |
|
Roles : boolean
set it to true to specify the type of configuration privileges available to users who are assigned to the role. |
|
Users : boolean
set it to true to specify the type of configuration privileges available to users who are assigned to the role. |
|
WebConfigEnable : boolean
set it to true to specify the type of configuration privileges available to users who are assigned to the role. |
|
Workbench : boolean
set it to true to specify the type of configuration privileges available to users who are assigned to the role. | |
|
Privileges : CimPrivileges
Contains the previliges related to security
|
ChangeApprovalVerify : boolean
set it to true to specify this privileges available to users who are assigned to the role. |
|
DeleteAlarms : boolean
set it to true to specify this privileges available to users who are assigned to the role. |
|
DisableOrModifyAlarms : boolean
set it to true to specify this privileges available to users who are assigned to the role. |
|
DynamicConfiguration : boolean
set it to true to specify this privileges available to users who are assigned to the role. |
|
ModifyAlarmSetups : boolean
set it to true to specify this privileges available to users who are assigned to the role. |
|
ModifyAttributes : boolean
set it to true to specify this privileges available to users who are assigned to the role. |
|
OPCUAServerAdmin : boolean
set it to true to specify this privileges available to users who are assigned to the role. |
|
PointByAddress : boolean
set it to true to specify this privileges available to users who are assigned to the role. |
|
PointTarget : boolean
set it to true to specify this privileges available to users who are assigned to the role. |
|
ProcessControl : boolean
set it to true to specify this privileges available to users who are assigned to the role. |
|
RightClickMenu : boolean
set it to true to specify this privileges available to users who are assigned to the role. |
|
ScriptControl : boolean
set it to true to specify this privileges available to users who are assigned to the role. |
|
SetPoint : boolean
set it to true to specify this privileges available to users who are assigned to the role. |
|
SetpointAuditTrail : boolean
set it to true to specify this privileges available to users who are assigned to the role. |
|
StartProject : boolean
set it to true to specify this privileges available to users who are assigned to the role. |
|
StopProject : boolean
set it to true to specify this privileges available to users who are assigned to the role. |
|
TriggerEvents : boolean
set it to true to specify this privileges available to users who are assigned to the role. |
|
Level : integer
is a number to indicate the level at which the role can set points. | |
|
RoleID : string
The Id of role. | |
|
DynCreate : boolean
| |
200 Response
The response body is of type ItemsPostResponse.
The collection of results from the roles create/update operation
Overview
|
ItemsPostResponse
The results of the create/update/delete operations.
|
NumSuccesses : number
The number of items that were successfully written. |
|
NumFailures : number
The number of items that failed to be written. |
|
WarningsMask : integer
a bitmask of warning conditions (e.g., WarningLicensePointCount) |
|
ItemResults : Array[ItemResult]
The results for each item in the request array.
|
Success : boolean
high level result (success true, failure false) |
|
StatusDetails : integer
a value giving more details about the status (e.g., SuccessNew, SuccessModified, FailureDupInRequest, FailureDupInObject, and then a bunch of FailureXyzzy, ...) |
|
WarningsMask : integer
a bitmask of warning conditions (e.g., IE_SNF_NO_GLB_TRIG_MSG) |
|
Message : string
(localized?) message about the result, probably empty for successes | | |
Fault Responses
| Fault | Description |
|---|
| 404 | This fault returns a response body of type ProblemDetails. Error if objects not found |
| 400 | This fault returns a response body of type ProblemDetails. General error |
See Also
